Create Customer Availability Zone

This API is used to create a new customer-defined (user-defined) availability zone.

HTTP URL  
POST api/v2/customer/{id}/availability-zone

Eligibility

The Requester is eligible to create a new availability zone for its own use. The Requester is not eligible to create a new availability zone at any other customer level, including its own sub-accounts.

API Request

Request Structure

Element Type M/O/CM Description
name String M Availability zone name
description String O

Availability zone description.

It is highly recommended to provide a meaningful description.
zone String M Array of Zone UUIDs (can be system or user-defined zones)

API Response

Response Structure

Parameter Type M/O/CM Description
errorCode String O Failure code.
errorMessage String O Failure message.
content Object O

Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable Object O

Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element Type M/O/CM

Description
requestId UUID M

Request instance ID.

To be used by external systems to query the call (operation) status:

  • In progress

  • Successful

  • Failed
availabilityZoneId UUID M

New availability zone ID generated universally unique identifier

Pageable data objects

Element Type M/O/CM Description
page Numeric M Page number
size Numeric M Page size. Number of requested elements per page
totalPages Numeric M Total amount of available pages per requested page size
totalElements Numeric M Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code Message
GLOBAL_1001 Service unavailable. Please try again

Examples

Request Body

Copy 
{
  "name": "North America 05",
  "description": "All Canadian regions and north USA region",
  "zone": [
    "ff74dca6-8e7f-4b85-a42b-13860913b370",
    "ceb892d2-f24b-4007-bf81-999fe75cb635",
    "40007bac-a0bc-4e43-a955-1207e7d546dd"
  ]
}

Response Body: Success ACK

Copy 
{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
      "availabilityZoneId": "f0007bac-8e7f-f24b-a42b-999fe75cb630"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy 
{
  "errorCode": "GLOBAL_1001",
  "errorMessage": "Service unavailable. Please try again",
  "content": "",
  "pageable": ""
}